Auction examples
Webhook examples
Toppie API
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Agency Account Report.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Account Activity Reports.
- GETGet Agency Daily Kpis By Product Dump Urls
- GET[BETA] List Account Products
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Campaign API
- GETGet Restriction Types
- GETGet Json Templates
- POSTCreate Json Template
- GETGet Campaigns
- POSTCreate Campaign
- POST[BETA] Get estimated clicks of a future campaign for a given vendordeprecated
- GETGet Sponsored Productsdeprecated
- GETGet Products In Campaign
- POST[BETA] Create exclusive listing campaign.
- POST[BETA] Create exclusive banner campaign.
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- GETGet Restriction Type
- GETGet Json Template
- PATCHUpdate Json Template
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete All Bids From A Campaign
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- GETGet Campaign Products
- PUTUpsert Campaign Products
- GET[BETA] Get exclusive listing campaign by ID.
- PATCH[BETA] Update exclusive listing campaign by ID.
- GET[BETA] Get exclusive banner campaign by ID.
- PATCH[BETA] Update exclusive banner campaign by ID.
Catalog API
Billing API
- GETGet Marketplace Credit Limitdeprecated
- POSTSet Marketplace Credit Limitdeprecated
- GETGet Vendor Chargesdeprecated
- GETGet Billing Contacts
- PUTUpsert Vendor Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- GETGet Vendor Credit Limitdeprecated
- POSTSet Vendor Credit Limitdeprecated
- GETGet Vendor Credit Historydeprecated
- GETGet Vendor Account Activitydeprecated
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- POSTAdjust Wallet Balance
- GETGet Billing Contact
- PUTUpsert Billing Contact
- DELDelete Vendor Billing Contact
Reporting API
- GETGet Marketplace Report
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Interactions Report
- GETGet Scored Attribution Dump Urls
- GETGet Interactions Dump Urls
- GETGet Vendor Report
- GETGet Vendor Daily Report
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Product Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
Invitation API
Assets API
Segments Service
Offsite Ads API
- POSTCreate a new advertiser
- GETGet vendor offsite campaigns
- POSTCreate Campaign
- GETList Audiences
- POST[BETA] Create offsite user list audience job.
- PUTUpsert Advertiser Domain
- GETGet Job Status
- GETGet advertiser onboarding state for a specific DSP
- GETGet campaign information
- PATCHUpdate Campaign
- GETGet Campaign Products Report
- GETGet Campaign Aggregated Report
- GETGet Campaign Daily Report
Forecasting Service
API Reference
[BETA] Get Toppie Campaigns
Copy
Ask AI
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/campaigns \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"hasMore": true,
"campaigns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"adFormat": "banner",
"chargeType": "CPM",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"budget": 123,
"budgetPeriod": "daily",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"targetRoas": 10.25,
"currencyCode": "<string>",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"bidCount": 123
}
],
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}Toppie API
[BETA] Get Toppie Campaigns
Retrieve a list of campaigns associated with a specific account.
GET
/
public
/
v1
/
toppie
/
campaigns
[BETA] Get Toppie Campaigns
Copy
Ask AI
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/campaigns \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"hasMore": true,
"campaigns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"adFormat": "banner",
"chargeType": "CPM",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"budget": 123,
"budgetPeriod": "daily",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"targetRoas": 10.25,
"currencyCode": "<string>",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z",
"bidCount": 123
}
],
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}Authorizations
A valid API key generated in Topsort's UI.
Query Parameters
Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.
Limit of accounts to retrieve.
Required range:
x <= 100Response
Successful Response
Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.
List of campaigns that belong to the agency
Show child attributes
Show child attributes
Internal identifier for the agency campaign
Campaign name
The ad format for this campaign
Available options:
banner, listing The charge type for this campaign
Available options:
CPM, CPC, CPA Account that owns this campaign
Total budget for this campaign
The periodicity of the budget
Available options:
daily, weekly, monthly, total Target ROAS for the campaign
Required range:
0.5 <= x <= 20Currency code this campaign is working with in ISO 4217 format
Flag to indicate if the campaign is active or not
Date and time when the campaign was created
Bid count for the campaign (optional)
Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.
Minimum string length:
1Example:
"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
Was this page helpful?
⌘I